feat: gif support for profile picture by TakuyaYagam1 · Pull Request #1366 · caelestia-dots/shell

TakuyaYagam1 · 2026-04-01T19:35:29Z

Summary

Add animated GIF support for profile pictures (~/.face)
New ProfileImage component that detects image format via magic bytes (QImageReader) and switches between AnimatedImage (GIF) and CachingImage (static)
GIF added to file picker filter so users can select .gif files directly

Changes

CUtils::imageFormat() — new C++ method for format detection without file extension
components/images/ProfileImage.qml — Loader-based component switching between animated/static rendering
Updated User.qml (dashboard) and Center.qml (lock screen) to use ProfileImage
Added gif to valid image types in Images.qml

gif.mp4

Purple squares are an unrelated icon loading issue, not caused by this PR.

Copilot

Pull request overview

Adds animated GIF support for profile pictures (~/.face) by introducing a format-detecting ProfileImage component that switches between animated and static rendering.

Changes:

Add gif to supported image types/extensions for the file picker.
Introduce CUtils::imageFormat() (QImageReader-based) for extension-independent format detection.
Replace CachingImage usage with ProfileImage in dashboard and lock screen profile-picture views.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
utils/Images.qml	Extends allowed image extensions/types to include GIF.
plugin/src/Caelestia/cutils.hpp	Exposes new QML-invokable `imageFormat()` helper.
plugin/src/Caelestia/cutils.cpp	Implements format detection via `QImageReader::imageFormat()`.
modules/lock/Center.qml	Switches lock-screen avatar rendering to `ProfileImage`.
modules/dashboard/dash/User.qml	Switches dashboard avatar to `ProfileImage` and triggers reload after picker accept.
components/images/ProfileImage.qml	New loader-based component selecting `AnimatedImage` vs `CachingImage`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-01T19:39:15Z

+
+    function reload(): void {
+        _format = CUtils.imageFormat(path);
+        loader.active = false;
+        loader.active = true;
+    }
+


reload() assigns to _format, which removes the existing QML binding (property string _format: CUtils.imageFormat(path)). After the first reload, _format will no longer update automatically when path changes, so the component can get stuck using the wrong renderer. Consider keeping _format as a binding (e.g., reassign via Qt.binding(...)) or refactor so reload forces a reload without breaking the binding.

Copilot · 2026-04-01T19:39:16Z

+            fillMode: AnimatedImage.PreserveAspectCrop
+            asynchronous: true
+            playing: true
+            source: `file://${root.path}`


AnimatedImage.source is built as file://${root.path}, which can produce malformed file URLs for absolute paths (e.g. file:////home/...) and won’t URL-escape characters like spaces. Elsewhere in the codebase AnimatedImage.source is set to a plain local path string (e.g. Paths.absolutePath(...)), which avoids these issues. Prefer using the local path directly (or a proper file-URL constructor) here.

Suggested change

source: `file://${root.path}`

source: root.path

TakuyaYagam1 · 2026-04-01T19:58:33Z

CI failures are pre-existing and unrelated to this PR:

No PanelWindow backend loaded - Wayland backend unavailable in CI

Member "status" not found on type "QObject" - qmllint limitation with Loader.item type resolution

Unused import qs.utils in Center.qml - false positive, Paths.home is used from it

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-02T11:36:51Z

+    property string path
+    property string _format: CUtils.imageFormat(path)
+
+    readonly property int status: (loader.item as Image)?.status ?? Image.Null


status is derived via (loader.item as Image)?.status, but the loaded item can be an AnimatedImage (not an Image), causing the cast to fail and status to stay Image.Null for GIFs (placeholder will never hide). Use loader.item?.status ?? Image.Null (optionally suppress qmllint like other image wrappers do).

Suggested change

readonly property int status: (loader.item as Image)?.status ?? Image.Null

readonly property int status: loader.item?.status ?? Image.Null

Copilot · 2026-04-02T11:36:51Z

+            fillMode: AnimatedImage.PreserveAspectCrop
+            asynchronous: true
+            playing: true
+            source: Qt.resolvedUrl(`file://${root.path}`)


The AnimatedImage source URL is built as file://${root.path}, which produces malformed URLs for normal absolute paths (e.g., /home/... becomes file:////home/...) and can also mis-handle relative paths (treated as a host). Prefer generating a proper local-file URL (e.g., resolve the local path directly, or use a helper that produces file:///...).

Suggested change

source: Qt.resolvedUrl(`file://${root.path}`)

source: Qt.resolvedUrl(root.path)

Copilot · 2026-04-02T11:36:52Z

+        AnimatedImage {
+            fillMode: AnimatedImage.PreserveAspectCrop
+            asynchronous: true
+            playing: true
+            source: Qt.resolvedUrl(`file://${root.path}`)
+        }
+    }
+
+    Component {
+        id: cachingComponent
+
+        CachingImage {
+            path: root.path
+        }


The loaded AnimatedImage/CachingImage items are not sized to the Loader (no anchors.fill: parent / width+height binding), so the profile image may render at its implicit size instead of filling the avatar container. Add sizing/anchors inside both components so they always fill root like the previous direct CachingImage usage did.

Copilot · 2026-04-02T11:36:52Z

    Q_INVOKABLE bool copyFile(const QUrl& source, const QUrl& target, bool overwrite = true) const;
    Q_INVOKABLE bool deleteFile(const QUrl& path) const;
    Q_INVOKABLE QString toLocalFile(const QUrl& url) const;
+    Q_INVOKABLE QString imageFormat(const QString& path) const;


New CUtils::imageFormat takes a raw QString path, unlike the other filesystem-related helpers here which take QUrl and validate isLocalFile(). Consider switching this API to QUrl (and rejecting non-local URLs) so QML call sites are consistent and you don’t accidentally pass a qrc://remote URL string that will always return an empty format.

Suggested change

Q_INVOKABLE QString imageFormat(const QString& path) const;

Q_INVOKABLE QString imageFormat(const QUrl& url) const;

QString imageFormat(const QString& path) const;

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-02T11:52:59Z

+            fillMode: AnimatedImage.PreserveAspectCrop
+            asynchronous: true
+            playing: true
+            source: Qt.resolvedUrl(`file://${root.path}`)


AnimatedImage.source is built via Qt.resolvedUrl(file://${root.path}), which can produce non-canonical/invalid file URLs for absolute paths (e.g., file:////home/...) and differs from existing AnimatedImage usage in the repo (which passes an absolute local path string). Prefer using Qt.resolvedUrl(root.path) (no manual file:// prefix) or pass root.path directly to let QML convert the local path to a URL correctly.

Suggested change

source: Qt.resolvedUrl(`file://${root.path}`)

source: Qt.resolvedUrl(root.path)

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-02T12:06:02Z

+    readonly property list<string> validImageTypes: ["jpeg", "png", "webp", "tiff", "svg", "gif"]
+    readonly property list<string> validImageExtensions: ["jpg", "jpeg", "png", "webp", "tif", "tiff", "svg", "gif"]


Adding gif to the global validImageExtensions affects every FileDialog using this list (e.g., wallpaper picker) and will allow selecting GIFs even where only static rendering is supported. Consider scoping this to profile-picture selection (separate list) or ensuring all consumers can handle GIFs appropriately.

TakuyaYagam1 · 2026-04-29T20:02:28Z

Quick update: I rebased the PR on top of the latest upstream changes after the new image cache provider merge.

I tested an additional follow-up that moved image format detection into Caelestia.Images.IUtils and disabled QML memory cache for profile images, but that version regressed GIF loading on my NixOS setup, so I rolled it back for now.

The current branch keeps the stable behavior:

GIF profile pictures use AnimatedImage, preserving animation.
Static profile pictures continue to use the upstream CachingImage path.
Global CachingImage behavior is unchanged.

I’ll keep the PR focused on the working GIF support first, and can revisit deeper integration with the new image utils/cache provider separately if needed.

TakuyaYagam1 · 2026-04-30T15:54:14Z

Updated this PR after the upstream image cache provider changes.

The current version keeps GIF profile pictures on AnimatedImage, so animation is preserved and GIFs do not go through the static image cache provider. Static profile pictures still use the upstream CachingImage path.

Follow-up polish included:

disabled QML memory cache only for profile images, so replacing ~/.face updates reliably;
deferred dashboard profile image reload after picker accept;
made image extension checks case-insensitive for .GIF, .PNG, .JPG, etc.

I intentionally avoided changing global CachingImage behavior and left MP4/WebM support out of scope for this PR.

Tested on my NixOS setup by rebuilding Caelestia Shell and selecting/replacing GIF profile pictures. Everything works as expected.

…verload

Copilot AI review requested due to automatic review settings April 1, 2026 19:35

Copilot started reviewing on behalf of TakuyaYagam1 April 1, 2026 19:36 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

soramanew force-pushed the main branch from 1cffdc4 to 36aac87 Compare April 2, 2026 01:53

TakuyaYagam1 requested a review from Copilot April 2, 2026 11:32

Copilot started reviewing on behalf of TakuyaYagam1 April 2, 2026 11:32 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

TakuyaYagam1 requested a review from Copilot April 2, 2026 11:48

Copilot started reviewing on behalf of TakuyaYagam1 April 2, 2026 11:49 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

TakuyaYagam1 requested a review from Copilot April 2, 2026 12:00

Copilot started reviewing on behalf of TakuyaYagam1 April 2, 2026 12:00 View session

Copilot AI reviewed Apr 2, 2026

View reviewed changes

TakuyaYagam1 force-pushed the main branch 2 times, most recently from 63b6188 to 93d8368 Compare April 14, 2026 20:13

TakuyaYagam1 force-pushed the main branch 4 times, most recently from 13d7d2b to 0148a73 Compare April 29, 2026 19:59

TakuyaYagam1 force-pushed the main branch from 0148a73 to be2ecc3 Compare April 30, 2026 13:52

TakuyaYagam1 added 7 commits May 2, 2026 15:19

feat: gif support for profile picture

6ce1a7b

fix: lint import order and section order in ProfileImage and User

1b86b61

fix: lint import-order and section-order violations

0b72f79

fix: preserve format binding on reload and use resolved URL

d42cd0f

fix: cast loader item to Image for qmllint

6933492

fix: profile image status cast, loader sizing, and imageFormat QUrl o…

fc7c8b1

…verload

fix: simplify AnimatedImage source URL construction

31f8cac

TakuyaYagam1 added 6 commits May 2, 2026 15:19

fix: cast profile image status item

9ad33b5

fix: bypass profile image memory cache

acf18f3

fix: defer profile image reload

9ca86f0

fix: bypass profile gif memory cache

dae337b

fix: match image extensions case insensitively

d0c7ada

fix: match file dialog filters case insensitively

3d5d3f9

TakuyaYagam1 force-pushed the main branch from 5eb58c0 to 3d5d3f9 Compare May 2, 2026 12:19

	readonly property int status: (loader.item as Image)?.status ?? Image.Null
	readonly property int status: loader.item?.status ?? Image.Null

	source: Qt.resolvedUrl(`file://${root.path}`)
	source: Qt.resolvedUrl(root.path)

	Q_INVOKABLE QString imageFormat(const QString& path) const;
	Q_INVOKABLE QString imageFormat(const QUrl& url) const;
	QString imageFormat(const QString& path) const;

		readonly property list<string> validImageTypes: ["jpeg", "png", "webp", "tiff", "svg", "gif"]
		readonly property list<string> validImageExtensions: ["jpg", "jpeg", "png", "webp", "tif", "tiff", "svg", "gif"]

Uh oh!

Conversation

TakuyaYagam1 commented Apr 1, 2026

Summary

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

TakuyaYagam1 commented Apr 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

TakuyaYagam1 commented Apr 29, 2026

Uh oh!

TakuyaYagam1 commented Apr 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants